home *** CD-ROM | disk | FTP | other *** search
/ PC Media 4 / PC MEDIA CD04.iso / share / udos / viz424 / viz.doc < prev    next >
Text File  |  1992-07-10  |  65KB  |  1,354 lines

  1.     ╦═╗                     ╦═╗
  2.     ║ ║╦═╗╔═╗╔═╗╦═╗╔═╗╦╦╗   ║ ║╔═╗╔═╗╦ ╦╦╦╗╔═╗╦═╗╠═ ╔═╗╠═ ╔╗ ╔═╗╦═╗
  3.     ╠═╝║  ║ ║║ ║║  ╔═╣║║║   ║ ║║ ║║  ║ ║║║║╠═╝║ ║║  ╔═╣║   ║ ║ ║║ ║
  4.     ╩  ╩  ╚═╝╚═╣╩  ╚═╝╩ ╚   ╩═╝╚═╝╚═╝╚═╝╩ ╚╚═╝╩ ╚╚═╝╚═╝╚═╝═╩╝╚═╝╩ ╚
  5.  
  6.                       VIz
  7.                 Revision 4.24.0
  8.  
  9.            Copyright (c) 1989-1992, FM de Monasterio
  10.             Licensed Material - All rights reserved
  11.  
  12.  
  13.    CONTENTS
  14.         1.  SUMMARY
  15.         2.  REGISTRATION
  16.         3.  GENERAL INFORMATION
  17.             Hardware Commands Compatibility
  18.             CPU releases
  19.  
  20.         4.  ACCELERATION MODULE
  21.         5.  CURSOR ALTERNATION MODULE
  22.         6.  ANSI-COMPATIBLE FILTER MODULE
  23.             Coexistence with other ANSI filters
  24.             ANSI implementations
  25.  
  26.         7.  INSTALLATION & USAGE
  27.             Switches
  28.             Comments
  29.             Status/Usage/Help panels
  30.  
  31.         8.  INSTALLATION IN UPPER MEMORY
  32.             Direct upper-memory area loading
  33.             UMA loading via memory managers or DOS 5
  34.             UMA updating
  35.             UMA deallocation
  36.             Memory mapping utilities
  37.  
  38.         9.  BASIC TECHNICAL INFORMATION
  39.             Interrupts
  40.             CLS command & INT 29h
  41.             Environment variable 'VIZ'
  42.             DOS errorlevels
  43.  
  44.         10. COPYRIGHT & LICENSE
  45.             U.S. Government information
  46.             Upgrades
  47.             Limitations
  48.             Technical support
  49.  
  50.    1. SUMMARY
  51.  
  52.    VIz is a small resident program that accelerates BIOS (and DOS) video input
  53.    and output in text mode; it can be used with IBM-compatible MDA, EGA or VGA
  54.    adapter cards and Hercules HGC and HGC+ cards.  In its present release, VIz
  55.    produces video interference ("snow") in old CGA cards.
  56.  
  57.    In addition, VIz includes an independent, resident component for displaying
  58.    a block cursor, either continuously or alternating with a line cursor at an
  59.    adjustable rate of alternation.  The latter display is well suited for easy
  60.    localization of the cursor in some laptop screens.
  61.  
  62.    Finally, VIz also contains an independent, resident ANSI-filter driver that
  63.    mediates a subset of the ANSI escape sequences to control the console. This
  64.    filter can be used, instead of ANSI.SYS, to implement ANSI escape sequences
  65.    to control video display, with the advantage that can be turned off and on,
  66.    and removed from memory without rebooting.
  67.  
  68.    All 3 resident modules occupy a total of less than about 1800 bytes of RAM.
  69.    Depending on the system configuration and BIOS version, video accelerations
  70.    by a factor of between 2 and 10 have been obtained.
  71.  
  72.  
  73.  
  74.    2. REGISTRATION
  75.  
  76.    This software is user-supported; the present release, although lacking the
  77.    options marked by asterisks, is a fully usable program.  You may test this
  78.    release for (in)compatibilities with your system, but after the testing is
  79.    completed you are requested to order a registered copy of the full release
  80.    of the software from the address at the end of this documentation.
  81.  
  82.    If you would rather use this unregistered copy, consider making a donation
  83.    to the Children's Hospital of Washington DC, for indigent children in need
  84.    of medical care.  Every year in the USA, infant mortality claims the lives
  85.    of tens of thousands of children before their first year of life, and most
  86.    of them come from families below poverty level...  Please send to the same
  87.    address a check payable to the "PATIENT CARE FUND, CHILDREN'S HOSPITAL" on
  88.    the obverse, and marked "For Deposit Only" on the reverse.  Donations will
  89.    be sent to Children's Hospital.  Please identify the program for which you
  90.    are making the donation.
  91.  
  92.     ------------------------------------------------------------------
  93.     VIZ.REG contains a form needed to register or upgrade the Software
  94.     ------------------------------------------------------------------
  95.  
  96.    See the final part of this documentation for information on the Licensing,
  97.    Distribution, Warranty, and Limitation of Remedies of this software.
  98.  
  99.  
  100.  
  101.    3. GENERAL INFORMATION
  102.  
  103.    There are 3 basic ways of producing character-oriented, text video displays
  104.    in DOS computers: (1) using direct video memory mapping, which is extremely
  105.    fast but dependent on the video hardware and has a limited portability; (2)
  106.    via BIOS services, provided by the first "hidden" DOS boot file and usually
  107.    augmented by the video adapter, which are not as fast as direct mapping but
  108.    more portable; and (3) via DOS services, provided by the other "hidden" DOS
  109.    boot file and sometimes augmented via installable device drivers, which are
  110.    much slower than the other two approaches, but have greater portability and
  111.    permit additional operations such as redirection.
  112.  
  113.    Many of the DOS and BIOS video services can be accelerated using a resident
  114.    program that intercepts the calls made to such services, and implements the
  115.    video operation with faster instructions.  Because of the nature of DOS and
  116.    of BIOS services, the interception must occur at the input site of the BIOS
  117.    services (INT 10h) while it can occur at the input site (INT 21h) or output
  118.    site (INT 29h), or both, of the DOS services.
  119.  
  120.    VIz is a utility that accelerates many of the basic text-video services and
  121.    allows changing the video mode, page and font of the display as well as the
  122.    raw or normal mode of DOS video output.  When used in a VGA/EGA system, VIz
  123.    also permits control of the red, green and blue mixture that determines the
  124.    color of each of the 16 registers of the color palette, and the RGB mixture
  125.    can be modified to suit user preferences.  VIz also permits controlling the
  126.    frequency (pitch) of the bell's tone.
  127.  
  128.    VIz requires MS-DOS version 2 or higher (or a compatible operating system).
  129.    Upper-memory selfloading requires DOS version compatible with MS-DOS 3.0 or
  130.    later. A cyclical redundancy check (CRC) is performed each time the program
  131.    is executed.  Execution is cancelled if the CRC fails, since this indicates
  132.    code corruption.
  133.  
  134.  
  135.    HARDWARE COMMANDS COMPATIBILITY
  136.  
  137.    VIz updates cursor position through direct hardware commands. In most video
  138.    systems, such commands can be sent out as one 16-bit (Word) value or as two
  139.    successive 8-bit (Byte) values. The word-out method of addressing, which is
  140.    used by other programs (e.g., Microsoft WINDOWS), yields faster positioning
  141.    of the cursor but may not work with some older clone systems.
  142.  
  143.    Registered VIz releases use cursor word-out addressing; to verify that your
  144.    system can handle this method, you can enter the command 'VIZ ?H' to see if
  145.    the cursor appears at the indicated position. If not, the video system only
  146.    allows byte-out addressing, and registered users need to contact the vendor
  147.    for a byte-out release of VIz free of charge.
  148.  
  149.  
  150.    CPU RELEASES
  151.  
  152.    VIz is entirely written in assembly language. Each VIz revision consists of
  153.    4 processor-type releases (086, 268, 386, and 486), where the code has been
  154.    optimized for the specific type of 80x86 processor.  This is needed because
  155.    the processors currently available differ markedly in instruction execution
  156.    times, and the availability of memory caches affects those times further by
  157.    influencing both speed of instruction fetching and memory access.  The type
  158.    and degree of code optimization vary with the processor model.
  159.  
  160.    In addition to standard (086) assembly language instructions, the 286, 386,
  161.    and 486 releases of VIz also use 286-, 386- or 486-specific instructions in
  162.    real mode only (which is the native mode for 086 processors).  The releases
  163.    differ slightly in resident size.
  164.  
  165.  
  166.  
  167.    4. ACCELERATION MODULE
  168.  
  169.    VIz installs itself as a resident program that can be invoked repeatedly for
  170.    modification of its parameters, without producing multiple copies on memory;
  171.    the accelerator module of the resident uses less than 1000 bytes of RAM.  To
  172.    maximize speed of code, but minimize resident size, acceleration only occurs
  173.    for video page 0 in a text mode (1-3, color; 7, monochrome).  In other pages
  174.    or graphic modes, VIz becomes inactive and is automatically reactivated by a
  175.    change to page 0 in text mode.
  176.  
  177.    VIz updates relevant parameters in the BIOS data area (segment 40h), such as
  178.    cursor position (page 0 only) and type, video mode, page, and font, that are
  179.    also processed by VIz; while such updating degrades video acceleration time,
  180.    it also decreases the possibility of conflict with foreground utilities that
  181.    use BIOS data but bypass BIOS calls.
  182.  
  183.  
  184.  
  185.    5. CURSOR ALTERNATION MODULE
  186.  
  187.    To help cursor visualization in screens where the cursor is not easily seen,
  188.    as in some laptop displays, VIz provides a small resident module that allows
  189.    for the display of a (full-)block cursor, either continuously or alternating
  190.    with a line cursor. The alternation rate can be adjusted in steps of 54.9 ms
  191.    between about 0.055 s (/V1) and 5.5 s (/V99).  A zero alternation rate (/V0)
  192.    produces a continuously present block cursor. For the module to be loaded in
  193.    memory, VIz must be installed with any /V switch (see below), and it adds an
  194.    additional 100 bytes to the resident size of VIz.
  195.  
  196.    Very short or very long alternation rates are distracting or hard to follow.
  197.    When selecting a rate for laptop displays, start with a value of n=9 (.50 s)
  198.    or so.
  199.  
  200.    Block cursor alternation can be turned off by making this resident quiescent
  201.    with the switch /V+ (until its reactivation with /Vn). All cursor operations
  202.    use direct commands to the hardware, and assume register-level compatibility
  203.    with the Motorola 6845 CRT controller. This chip is present in MDA, CGA, and
  204.    HGC cards, while a 6845-compatible CRTC is a custom LSI chip in the IBM-EGA,
  205.    part of the Memory Controller Gate Array on the MCGA, or a part of the Video
  206.    Graphics Array on the VGA.
  207.  
  208.    The normal (hardware-controlled) blinking of the cursor is not eliminated by
  209.    VIz; hence, depending on the alternation rate selected, a two-beat frequency
  210.    may be noticeable.
  211.  
  212.  
  213.  
  214.    6. ANSI-COMPATIBLE FILTER MODULE
  215.  
  216.    The DOS files includes the filter ANSI.SYS, a console character driver that
  217.    mediates a subset of the standard escape sequences of the American National
  218.    Standards Institute (ANSI) for video services.  This filter also mediates a
  219.    supplementary subset for keyboard services (such as key reprogramming).
  220.  
  221.    VIz has a second, independently installable resident module that implements
  222.    standard ANSI escape sequences to control the console video functions. This
  223.    ANSI-compatible filter uses less than some 800 additional bytes of RAM when
  224.    installed.  Once installed, this ANSI filter module can be turned off or on
  225.    independently of the other modules, or jointly uninstalled from memory.
  226.  
  227.    The filter does not provide by itself much acceleration of DOS video input/
  228.    output as far as ANSI instructions are concerned.  Its advantages are small
  229.    resident size, the capability of being turned on or off, and its harmonious
  230.    working with the acceleration module of VIz.
  231.  
  232.  
  233.    COEXISTENCE WITH OTHER ANSI FILTERS
  234.  
  235.    The installation of the ANSI filter can be made contingent on not detecting
  236.    the presence of ANSI.SYS or another ANSI-like utility intercepting the FAST
  237.    CONSOLE interrupt (29h) of DOS, such as ANSI.COM (Copyright 1989 Ziff-Davis
  238.    Corp.), or the potential presence of such utilities may be ignored (and the
  239.    filter forced to install).
  240.  
  241.    The presence of an installed ANSI-like utility can be ascertained using the
  242.    Status/Usage/Help panel displayed when the command 'VIZ ?' is entered.  The
  243.    Status line at the bottom of the screen displays one of the following:
  244.  
  245.     ANSI.SYS    Indicates that interrupt 29h (see below) points to a
  246.             resident code containing a device driver header with
  247.             the attributes of a character device servicing calls
  248.             to INT 29h and the device name 'CON.' This is likely
  249.             to be ANSI.SYS or an ANSI-compatible device driver.
  250.  
  251.     ANSI.COM    Indicates that interrupt 29h (see below) points to a
  252.             resident code containing the string 'CON    ' at the
  253.             place where the device driver name should be, but it
  254.             does not contain other elements of the device driver
  255.             header.  This is an ANSI-compatible resident utility
  256.             of the type of ANSI.COM.
  257.  
  258.     ANSI: No    Indicates absence of the above conditions.
  259.  
  260.  
  261.    ANSI IMPLEMENTATIONS
  262.  
  263.    The ANSI-compatible filter supports the following subset of ANSI 3.64-1979,
  264.    standard escape sequences, to control console video functions (see your DOS
  265.    documentation of the ANSI.SYS commands):
  266.  
  267.     Selection of the foreground and background colors on a color display or
  268.     the text attributes on a monochrome display system. The sequence syntax
  269.     is <Esc>[#;...;#m, where # is 30-37 to select a foreground color, 40-47
  270.     47 to select a background color, and 0-1, 4-5 or 7-8 to select the text
  271.     attributes.
  272.  
  273.     Selection of the video mode (similar to using the MODE command of DOS).
  274.     The sequence syntax is <Esc>[=#h or <Esc>[=#l, where # is 0-6 or higher
  275.     (depending on the adapter card in use).
  276.  
  277.     Selection of word wrapping, i.e. whether lines longer than the width of
  278.     the screen are truncated. The sequence syntax is <Esc>[?7h or <Esc>[?7l
  279.     to turn word wrapping ON or OFF, respectively.
  280.  
  281.     Cursor positioning for the following sequences:
  282.  
  283.         <Esc>[r#;c#H  Move to specified row (r#) and column (c#)
  284.         <Esc>[r#;c#f  Same a previous sequence
  285.         <Esc>[r#A     Move cursor up by specified number of rows
  286.         <Esc>[r#B     Move cursor down by specified number of rows
  287.         <Esc>[c#C     Move forward the specified number of columns
  288.         <Esc>[c#D     Move backward the specified number of columns
  289.  
  290.         <Esc>[s       Store current position of the cursor
  291.         <Esc>[u       Restore to the position stored by <Esc>[s
  292.  
  293.         <Esc>[K       Erase from the cursor to end of the line
  294.         <Esc>[2J      Clear all rows and home cursor (this sequence
  295.                   preserves current color attribute)
  296.  
  297.    Not supported by the filter are the cursor-position-reporting ANSI sequence
  298.    (<Esc>[r#;c#R), and the supplementary set of escape sequences used by ANSI.
  299.    SYS to permit the reprogramming of the keyboard (i.e. <Esc>[#;'string';3p),
  300.    a set which is not part of the 1979 ANSI video standard.
  301.  
  302.  
  303.  
  304.    7. INSTALLATION & USAGE
  305.  
  306.    The enclosed utility INSTALL.EXE may be used to copy the program files to
  307.    a user-defined drive and directory, and--if so desired--to add statements
  308.    to the file AUTOEXEC.BAT so that the program is loaded automatically upon
  309.    booting and to append the user-defined directory to the PATH statement.
  310.  
  311.    The following describes the manual installation of VIz:
  312.  
  313.               VIZ [/Switches] [;Comments]
  314.  
  315.    It is recommended that VIz be installed before other residents also using
  316.    the BIOS interrupt 10h (video input/output).  Due to the intrinsic nature
  317.    of the implementation, VIz does not chain some the interrupt-10h calls to
  318.    residents located down the intercepted interrupt chain. In order for such
  319.    residents to have access to these data, they need to be loaded after VIz.
  320.    Thus, it may be convenient to install VIz early in the AUTOEXEC.BAT file.
  321.  
  322.    If you intend to make use of the resident ANSI filter in a more permanent
  323.    manner, VIz may also be installed just as described above; if you want to
  324.    remove the ANSI component after a given ANSI-oriented task, however, then
  325.    VIz should be the last resident to be installed.
  326.  
  327.    The driver ANSI.SYS needs not to be loaded or, if loaded, removed, to use
  328.    the ANSI resident of VIz.  However, if any ANSI-like utility were already
  329.    installed and active, and VIz were switched to its 'fast DOS' mode (/Z+),
  330.    such an utility might be unable to process escape sequences, unless these
  331.    sequences were sent directly to the CON device via INT-29h calls (instead
  332.    INT 21h).
  333.  
  334.    Once installed, the resident can be modified at any time by executing VIz
  335.    again with new command switches.
  336.  
  337.  
  338.    SWITCHES
  339.  
  340.    The switches can be entered from:
  341.  
  342.     (1) the DOS command line
  343.     (2) a batch file
  344.     (3) a DOS environment string with the format VIZ=/SWITCH1.../SWITCHn
  345.  
  346.    The switches are not case sensitive, and can be separated by any character
  347.    between space (ASCII 32) and backslash (ASCII 47).  The effects of some of
  348.    the switches, e.g., /N, are order sensitive.  Switches /A, /B, /C, /D, /I,
  349.    /M, /P, /R and /S are "sticky" as the video changes they produce remain in
  350.    effect even if VIz is quiescent or uninstalled.
  351.  
  352.    --------------------------------------------------------------------------
  353.    (*) Switches marked with asterisks are available only in registered copies
  354.    --------------------------------------------------------------------------
  355.  
  356.     SWITCH /?
  357.  
  358.      This switch displays the Status/Usage/Help panels, which are described in
  359.      more detail in the section below.  If a VGA or EGA is the active adapter,
  360.      the program saves the contents of the palette registers prior to changing
  361.      the video attributes for its various displays.  See section STATUS/USAGE/
  362.      HELP PANELS below.
  363.  
  364.      EGA users:  The default MS-DOS palette attributes are restored if the EGA
  365.                  BIOS fails to store the original video data.
  366.  
  367.  
  368. *    SWITCH /A[±]
  369.  
  370.      Installs a resident filter to implement (the video subset of) ANSI escape
  371.      sequences; the installation may be made contingent upon failure to detect
  372.      the presence of the DOS driver ANSI.SYS or some ANSI-like residents (/A),
  373.      or to ignore their potential presence (/A+).
  374.  
  375.      The ANSI module does not become resident unless switch /A[+] is specified
  376.      at the time VIz is being installed and cannot be added after installation
  377.      of the resident(s).
  378.  
  379.      Although the filter can take advantage of VIz acceleration, its operation
  380.      does not require the enabling of the resident accelerator module, and its
  381.      activity can be controlled independently with the following switches:
  382.  
  383. *      /A    If VIz is not yet installed, adds the ANSI filter module
  384.         to the resident code to be installed, provided that ANSI
  385.         or another logical device named 'CON     ' mediating int
  386.         29h (see #3 above) is not installed, and inactivates the
  387.         remapping of the EGA/VGA palette via /C+, /Cn:n, or /Cm.
  388.  
  389.  
  390. *      /A+   If VIz is not yet installed, adds the ANSI filter module
  391.         to the resident code to be installed, even when ANSI.SYS
  392.         or a similar CON utility has already been installed, and
  393.         inactivates the remapping of the EGA/VGA palette via /C+
  394.         /Cn:n, or /Cm.
  395.  
  396.         If VIz is already installed, and the resident filter was
  397.         made inactive with /A-, /A+ reactivates the ANSI filter.
  398.  
  399.  
  400. *      /A-   Inactivates the filter, if installed and active. It also
  401.         reactivates a previously active remapping of the EGA/VGA
  402.         palette.
  403.  
  404.      Defaults: /A = /A+; null switch = no resident on installation.
  405.  
  406.      Switch /A or /A+ automatically turns switch /Z off (/Z-) to insure that
  407.      all the DOS video output is directed to the console driver so that ANSI
  408.      escape sequences via StdOut can also be implemented by the ANSI filter.
  409.      In those cases where the ANSI escape sequences are directly sent by the
  410.      application to INT 29h, a faster DOS output is achieved with switch /Z+
  411.      after selecting switch /A[+].
  412.  
  413.  
  414. *    SWITCH /Bn
  415.  
  416.      Selects the color for the screen border in text modes, and the background
  417.      and border color in graphic modes.  This color is specified by <n>, a one
  418.      or two digit number representing the Red-Green-Blue mixture for the color
  419.      using an octal (base 8) format ranging from 0 to 77 (see Switch C below).
  420.  
  421.      Switch /C+ also sets the screen border; the default border for the EGA is
  422.      black, and the screen background attribute for other color adapters.
  423.  
  424.  
  425. *    SWITCH /Cn:m±?
  426.  
  427.      Allows for color changes in the EGA/VGA color palette, which consists of
  428.      16 registers, and is used to map video memory data into colors.  Both in
  429.      (the EGA-compatible modes of) the VGA and the EGA, the value in each one
  430.      of these registers determines the amount of Red, Green, and Blue mixture
  431.      in the displayed color.
  432.  
  433.      This amount can be represented by the data bits <RGBrgb>, where <000rgb>
  434.      shows the color at 33%, <RGB000> at 66%, and <RGBrgb> at 100% intensity.
  435.      These bits, and their resultant color, are shown below using both binary
  436.      (base 1) and octal (base 8) number formats:
  437.  
  438.        Binary    Octal      Color          Since the binary format takes up a
  439.      ┌─────────┬───────┬─────────────┐     lot of space it is more convenient
  440.      │ 000 000 │  00 + │ 100% black  │     to use the 2-digit octal format to
  441.      │ 000 001 │  01   │  33% blue   │     represent an RGB value. The binary
  442.      │ 000 010 │  02   │  33% green  │     equivalence of octal numbers is:
  443.      │ 000 011 │  03   │  33% cyan   │
  444.      │ 000 100 │  04   │  33% red    │
  445.      │ 000 101 │  05   │  33% magenta│         0o = 000000b
  446.      │ 000 110 │  06   │  33% yellow │         1o = 000001b
  447.      │ 000 111 │  07   │  33% white  │         2o = 000010b
  448.      ├─────────┼───────┼─────────────┤         3o = 000011b
  449.      │ 001 000 │  10 + │  66% blue   │         4o = 000100b
  450.      │ 010 000 │  20 + │  66% green  │         5o = 000101b
  451.      │ 011 000 │  30 + │  66% cyan   │         6o = 000110b
  452.      │ 100 000 │  40 + │  66% red    │         7o = 000111b
  453.      │ 101 000 │  50 + │  66% magenta│        10o = 001000b
  454.      │ 110 000 │  60 + │  66% yellow │        11o = 001001b
  455.      │ 111 000 │  70 + │  66% white  │        12o = 001010b
  456.      ├─────────┼───────┼─────────────┤        13o = 001011b
  457.      │ 001 001 │  11 + │ 100% blue   │        14o = 001100b
  458.      │ 010 010 │  22 + │ 100% green  │        15o = 001101b
  459.      │ 011 011 │  33 + │ 100% cyan   │        16o = 001110b
  460.      │ 100 100 │  44 + │ 100% red    │        17o = 001111b
  461.      │ 101 101 │  55 + │ 100% magenta│        20o = 010000b
  462.      │ 110 110 │  66 + │ 100% yellow │           etc
  463.      │ 111 111 │  77 + │ 100% white  │
  464.      └─────────┴───────┴─────────────┘
  465.        (+) IBM default color palette
  466.  
  467.      Of course, other colors can also be generated when using a different RGB
  468.      mixture value.  For instance, a desaturated (i.e., whitish) RGB sequence
  469.      is obtained in the octal range 71o through 76o.
  470.  
  471.      This palette control is also enabled (revision 2.42+) for the monochrome
  472.      mode of VGA and MCGA video adapters to remap color codes into gray-scale
  473.      values.  The following services are available:
  474.  
  475. *      /C:n  The RGB values of the palette registers is set by a 16-
  476.         number sequence in which these two-digit, octal numbers
  477.         are separated by colons (:) as in the following example
  478.  
  479.            /C03:00:20:30:40:50:01:77:70:11:22:33:44:55:66:76
  480.  
  481.         which shows the default palette colors used by VIz when
  482.         switch /C? is used.  If less than 16 numbers are given,
  483.         their RGB values are loaded into the respective palette
  484.         registers starting from register 0.  When a non-numeric
  485.         value is provided, the palette is not changed.
  486.  
  487.  
  488. *      /Cm±  The VGA and MCGA adapters emulates a 16-color text mode
  489.         for a monochrome display, and the palette consists of 4
  490.         groups of four shades of gray. In MONOCHROME modes, /Cm
  491.         loads a palette in which the gray-scale value increases
  492.         uniformly with increasing attribute values; the palette
  493.         corresponds to the following command
  494.  
  495.            /C00:50:01:31:61:12:42:03:43:04:44:05:55:26:07:77
  496.  
  497.         Switch /Cm can also be used with CGA monochrome systems
  498.         (e.g., laptops) to translate color attributes into gray
  499.         scale values.
  500.  
  501.         In COLOR modes, switch /Cm± enables [+] or disables [-]
  502.         the gray-scale summing of the RGB mixture. The summing,
  503.         carried out by the BIOS, sets the gray-scale equivalent
  504.         of a given color to 30%, 50%, and 11% of the Red, Green
  505.         and Blue value in the video digital-to-analog registers
  506.         (these percentages are close to the relative brightness
  507.         of the displayed 'pure' red, green, and blue).
  508.  
  509.  
  510.       /C?   This service provides a display of the palette registers
  511.         and the corresponding RGB mixture in octal format. It is
  512.         possible to alter the RGB mixture of any register simply
  513.         by pressing <R>, <G>, or <B> and then <> or <>.  These
  514.         arrows cycle through 0%, 33%, 66%, and 100% intensity of
  515.         the respective RGB component.  The actual RGB mixture of
  516.         the selection is also shown on a graph.  Press the right
  517.         or left arrow to cycle through the registers, and <HOME>
  518.         to go to register 0 or <END> to go to register 15.
  519.  
  520.         Press <ENTER> to save the current palette, <ESC> to quit
  521.         the service without any palette changes, <DEL> to reject
  522.         any change and to restart the service, and the indicated
  523.         function keys to load several available palettes.
  524.  
  525.  
  526. *      /C-   Use to inactivate the implementation of EGA/VGA palette
  527.         changes via VIz.  The video attributes remain unchanged
  528.         until the a video operation reloads the palette, e.g. a
  529.         video mode change.  Switch /A+ also turns off remapping
  530.         of the palette.
  531.  
  532.  
  533. *      /C+   Use to reactivate the implementation of EGA/VGA palette
  534.         changes via VIz; it reloads the last color palette that
  535.         was selected via VIz.  Switch /A- reactivates remapping
  536.         if remapping was in effect prior to an /A+ request.
  537.  
  538.      Defaults: /C = /C+.
  539.  
  540.      The selected EGA/VGA color palette changes are asserted (i.e. the palette
  541.      is loaded with the selected RGB values) each time a video mode change, or
  542.      a video font change, is requested and VIz is enabled (i.e., no /Q switch,
  543.      no graphics mode, and no video page other than 0).
  544.  
  545.      To preserve the small size of Viz, there is no hotkey pop-up service.  If
  546.      during the execution of an application the color palette changes, the RGB
  547.      values selected via VIz cannot be asserted except by shelling to DOS (and
  548.      executing VIz with the switch /C+ to reload the palette) or by triggering
  549.      a video mode/font change.
  550.  
  551.  
  552. *    SWITCH /D[±n]
  553.  
  554.      Adjusts brightness of screen (VGA card only); the brightness change step
  555.      is specified by the sign and value of <±n>, which is a decimal number of
  556.      1 or 2 digits, with or without a sign, in the range from -63 to +63. Use
  557.      of high negative or positive numbers can result in an unreadable screen.
  558.      Selection of /D0 results in the restoration of the screen to its default
  559.      settings (as dictated by the manual controls of the monitor).
  560.  
  561.      Defaults: /D = /D+2; /D1 = /D+1; /D- = /D-2.
  562.  
  563.  
  564. *    SWITCH /E
  565.  
  566.      Creates or updates the variable VIZ=/SWITCH1.../SWITCHn in the DOS global
  567.      environment, where /SWITCH1.../SWITCHn are the switches to be implemented
  568.      when VIz is executed from the DOS command line without any arguments.  If
  569.      the 'VIZ' variable already exists, switch /E updates the contents of this
  570.      variable.  Although switch /E is incorporated into the variable contents,
  571.      its presence is ignored when VIz uses this variable as input.
  572.  
  573.      Switch /E modifies the DOS global environment irrespective of whether the
  574.      resident shell is the initial copy of COMMAND.COM (global environment) or
  575.      a secondary copy (local environment).  See the INSTALLATION section below
  576.      for more details.  No defaults.
  577.  
  578.  
  579. *    SWITCH /F[Htg][n±]
  580.  
  581.      If VIz detects a HERCULES card adapter (HGC or HGC+), switch /FHt changes
  582.      the card to text mode (80x25) whereas switch /FHg changes the card to its
  583.      default (page 0) 720x348 graphics mode.
  584.  
  585.      If VIz detects an EGA or VGA adapter, switch /Fn permits the selection of
  586.      the number of screen rows to be displayed.  The following video fonts are
  587.      supported: 12 or 14 (EGA or VGA), 25 (EGA and VGA), 28 (VGA), 35 (EGA and
  588.      VGA) and 43 or 50 (EGA or VGA) screen rows.  Except for the 12/14 and 35-
  589.      row fonts, implementation of the selected font is maintained until switch
  590.      /F-, which disables font implementation, or another font is selected; the
  591.      font implementation can be reenabled with /F+.
  592.  
  593.      If a number <n> is not specified, switch /F toggles between 25-row and 43
  594.      (EGA) or 50-row (VGA) screens.  (If an EGA/VGA adapter is found, VIz also
  595.      selects the alternate BIOS print-screen service to avoid the default BIOS
  596.      print-screen routine that works with 25 rows only.)  For a 25-row screen,
  597.      an 8x14 font is used in an EGA and a 9x16 font in a VGA.  Fonts with more
  598.      than 25 rows can be loaded only if the video page is between 0 and 3.
  599.  
  600.      No defaults.
  601.  
  602.  
  603. *    SWITCH /G[n]
  604.  
  605.      The frequency in Hz (cycles per second) of 55-ms bell tones is specified
  606.      by <n>, a decimal number of up to 4 digits, in the range from 25 to 5000
  607.      Hz.  Values below 25 become 25 Hz and above 5000 become 5000 Hz; if more
  608.      than 4 digits are given only the four least-significant digits are used,
  609.      e.g., 50,000 Hz is read as 0000, triggering the use of 25 Hz.
  610.  
  611.      The bell tones always last 55 ms (one tick of the 8253/8254 timer chip).
  612.      Since the tones are forced to begin at the start of a 55-ms tick period,
  613.      stacked bell rings will result in a distinctive, staccato-like burst due
  614.      to the intervening silent 55-ms tick periods.
  615.  
  616.      Most computer speakers seem to work properly within the range from about
  617.      100 Hz to about 3,000 Hz.  Frequencies for the octave starting at middle
  618.      are C=523 Hz, D=587 Hz, E=659 Hz, F=699 Hz, A=880 Hz, and B=988 Hz.  The
  619.      frequencies for higher [lower] octaves increase [decrease] approximately
  620.      by a factor of 2 per octave change from the above values.
  621.  
  622.      Defaults: /G = /G440.
  623.  
  624.  
  625. *    SWITCH /H[n][@]
  626.  
  627.      Loads the resident in the Upper Memory Area (UMA), between addresses 640
  628.      KB and 1,024 KB of memory; this is the region below the 1-MB boundary of
  629.      the memory accessible by 086 CPUs, but above the 640-KB hardware barrier
  630.      of MS-DOS.  The switch requires an available upper memory block (UMB) of
  631.      about .9 to 1.7 KB (depending on the number of modules to be installed),
  632.      which is allocated by the program itself either via a direct XMS request
  633.      or, when DOS controls the UMB allocation (i.e. DOS 5.0 linked to the UMA
  634.      through the command DOS=UMB in CONFIG.SYS), via DOS calls. Allocation of
  635.      UMBs requires the presence of an XMS manager (XMM) that supports the UMB
  636.      services 10h-11h of the XMS 2.0, and (if the XMM lacks the capability of
  637.      remapping memory) the presence of an UMB provider.
  638.  
  639.      A lower upper-memory limit for the UMB loading can also be requested via
  640.      switch /Hn, in which <n> is a four-digit hexadecimal number between A000
  641.      (640 KB) and FFFF (1,024 KB), in order to avoid or select specific areas
  642.      of upper memory.
  643.  
  644.      A lower-memory resident marker can also be installed along with the UMB
  645.      resident via switch /H@ or /Hn@; the marker occupies 144 bytes of lower
  646.      conventional memory, can be identified in some memory mapping utilities
  647.      by the name
  648.                    VIz @ UMB
  649.  
  650.      and is released from memory when the UMB resident is uninstalled.  This
  651.      marker may be used (1) to remind that the resident is already installed
  652.      in upper memory, (2) to help locate the UMB installation address in the
  653.      case of some mapping utilities, and (3) to help avoid removal conflicts
  654.      when lower and upper-memory residents are interspersed.
  655.  
  656.      Defaults:  Low-memory installation if any error is found during the UMB
  657.      loading; high-memory installation below lower-address limit if UMBs are
  658.      not available above such limit.
  659.  
  660.  
  661. *    SWITCH /I±
  662.  
  663.      Selects how background color attributes with a hexadecimal value in the
  664.      range from 8h to Fh (bit 7=1) are displayed in text modes.
  665.  
  666.       /I-   High-bit attributes produce a blinking character on a
  667.         background of normal (medium) intensity.
  668.  
  669.       /I+   High-bit attributes result in a steady character on an
  670.         intense background.
  671.  
  672.      Defaults: Null switch = /I- on installation.
  673.  
  674.  
  675. *    SWITCH /K±
  676.  
  677.      Disables [+] or enables [-] access of the CPU to video RAM in VGA/MCGA.
  678.      It can be used to kill BIOS-mediated displays that cannot be redirected
  679.      to the NUL device.
  680.  
  681.       /K-   Enable CPU access to video RAM (normal display).
  682.  
  683.       /K+   Disable CPU access to video RAM (blanked display).
  684.  
  685.      Defaults: /K = /K+; null switch = /K- on installation.
  686.  
  687.  
  688. *    SWITCH /Mn
  689.  
  690.      Selects the video mode specified by <Hn>, in which <n> is a hexadecimal
  691.      number between 0 and FF, or <Dn>, where <n> is a decimal number between
  692.      0 and 255. NOTE: There is no checking that the selected mode is a valid
  693.      one for the adapter in use.  No defaults.
  694.  
  695.  
  696. *    SWITCH /N±
  697.  
  698.      Determines whether or not noncritical program messages are displayed.
  699.  
  700.       /N-   Noncritical messages are displayed via the redirectable
  701.         StdOut device of DOS.
  702.  
  703.       /N+   Noncritical messages are not displayed, in which case a
  704.         a brief bell tone is sounded when a error has occurred.
  705.  
  706.      Defaults: /N = /N+; null switch = /N- on installation.
  707.  
  708.      Since VIz beeps when a command error is detected, /N- should need to be
  709.      used only after such a beep to display the error message again.  Please
  710.      note that the installing, uninstalling, and critical-error VIz messages
  711.      cannot be redirected and are always displayed.  The final status of the
  712.      operation can be monitored in batch files with the ERRORLEVEL commands.
  713.  
  714.  
  715. *    SWITCH /Pn
  716.  
  717.      Selects the video page specified by a number <n> in the range of 0 to 7
  718.      for 25-row display EGA/VGA, 0 to 3 for 43/50-row display EGA/VGA, and 0
  719.      to 3 for CGA.  No defaults.
  720.  
  721.  
  722.     SWITCH /Q
  723.  
  724.      Forces the video accelerator into a quiescent mode; if loaded, the ANSI
  725.      filter and the Cursor blink resident are NOT inactivated.  The overhead
  726.      video time for having VIz quiescent is an additional 2% or less of that
  727.      without VIz.  (Even when it is quiescent or during graphic video modes,
  728.      the accelerator still monitors the video interrupt to check for page or
  729.      mode change requests.)  A quiescent mode lasts until the next execution
  730.      of the program, unless switch /Q or /? has been selected.  No defaults.
  731.  
  732.  
  733. *    SWITCH /R±
  734.  
  735.      Selects the mode of processing text output that is used by DOS.  In the
  736.      normal ('cooked') mode, the kernel builds a device request for a single
  737.      character output, makes a Ctrl-C check, and then passes this request to
  738.      the StdOut console device; if no error is found, the buffer pointer and
  739.      character count are updated.  This process is repeated until either the
  740.      end-of-file character (ASCII 26, Ctrl-Z) is found or all characters are
  741.      processed.  Tabs (ASCII 9) are expanded to 8 spaces.
  742.  
  743.      In the binary ('raw') mode, instead of filtering the stream for control
  744.      characters, DOS passes a single request header to the device.  Control-
  745.      C, Control-P, and Control-S keyboard entries are not checked during I/O
  746.      operations.  Depending on the DOS version, DOS-mediated video output in
  747.      binary mode is faster by factor of about 1.40 or so.
  748.  
  749.       /R-   Changes DOS processing to the normal or 'cooked' mode.
  750.  
  751.       /R+   Changes DOS processing to a binary or 'raw' mode.
  752.  
  753.  
  754.      Defaults: Null switch = /R- on installation.
  755.  
  756.      When executed, some utilities set the DOS processing mode to 'raw,' and
  757.      then change it to normal when they finish, irrespective of the original
  758.      mode.  Other utilities set the mode to 'raw' and leave it on.  Repeated
  759.      use of switch /R+ may be necessary to maintain the binary DOS mode.
  760.  
  761.      NOTE: If the DOS binary mode is selected, the 'BREAK=ON' command should
  762.        also be issued to facilitate the detection of 'Control-C' entries
  763.        during disk and other DOS operations.
  764.  
  765.  
  766. *    SWITCH /S[n±]
  767.  
  768.      Enables [Sn+] or disables [Sn-] special services triggered by some keys
  769.      that can have untoward effects under some circumstances, especially for
  770.      LAN servers.
  771.  
  772.       /S1±  Enables [+] or disables [-] the printing of the screen
  773.         triggered by the <PrtSc> key.  /S1- is useful when the
  774.         number-pad keys are used often, and the possibility of
  775.         triggering unwanted prints is commensurably high. More
  776.         importantly, if the machine is not connected to an on-
  777.         line printer, <PrtSc> will freeze the system.
  778.  
  779.       /S2±  Enables [+] or disables [-] the dynamic halt, which is
  780.         triggered by the <Pause> key (PS/2s and COMPAQs) or by
  781.         the <Ctrl><NumLock> combination (in PCs).  The halt is
  782.         maintained until another key is pressed.  This service
  783.         is available only if the Cursor module is also loaded.
  784.  
  785.      Defaults: /S = /S1+; /S = /S1+; /S2 = /S2+; null switch = /Sn+ on
  786.                installation.
  787.  
  788.  
  789.      If /S1± (or /S± or simply /S) is requested at the time of installation,
  790.      VIz also selects the alternate BIOS print-screen service if the adapter
  791.      is an EGA or VGA, in order to handle screen lengths longer than 25 rows
  792.      (this alternate service is needed if other screen fonts are to be used,
  793.      since the BIOS default service only prints 25 lines.
  794.  
  795.      Some EGAs do not work properly when this alternate print-screen service
  796.      is enabled.  If the selection of switch /S1± during installation yields
  797.      a print-screen malfunction, install VIz without selecting /S1±, /S±, or
  798.      /S±, and only then select switch /S1 in a subsequent execution.
  799.  
  800.  
  801.     SWITCH /U
  802.  
  803.      Uninstalls the resident from memory.  The request is not honored if any
  804.      of the interrupt vectors intercepted by the program do not point to the
  805.      resident, indicating subsequent installation of other resident(s) using
  806.      the same interrupt(s) or the revectoring of such interrupts by a prior,
  807.      ill-behaved resident.
  808.  
  809.      In general, the program should be uninstalled only when it was the last
  810.      resident to be loaded; in practice, however, it can also be uninstalled
  811.      if subsequently loaded residents do not hook the same interrupts as the
  812.      program (even though this increases memory fragmentation, the resulting
  813.      "hole" is innocuous, and may be used by DOS for other purposes, such as
  814.      local environment blocks).  No defaults.
  815.  
  816.  
  817.     SWITCH /V±n
  818.  
  819.      Selects the loading of the resident cursor module. This module does not
  820.      become resident unless /V+ or /Vn is specified at the time VIz is being
  821.      loaded; this module cannot be added to the resident after installation.
  822.  
  823.       /Vn   Enforces a cursor whose shape alternates between a full
  824.         block and a thin line, in which <n> is a decimal number
  825.         (of 1 or 2 digits) specifying the alternation rate from
  826.         0.055 s [/V1] to 5.5 s [/V99].
  827.  
  828.       /V0   Forces the display of a continuous, full block cursor.
  829.  
  830.       /V-   Disables the display of the cursor.  Due to a potential
  831.         BIOS conflict, switch /V- is ignored at the time of VIz
  832.         loading; to make the cursor invisible, first use /V+ or
  833.         /Vn and then /V-.
  834.  
  835.       /V+   Reverses the cursor changes produced by /Vn and /V-.
  836.  
  837.      Defaults: /V = /V+; null switch = no resident on installation.
  838.  
  839.  
  840. *    SWITCH /X±
  841.  
  842.      If the DOS video output to the Standard Output device (StdOut) is being
  843.      mediated by VIz (see switch /Z±), switch /X controls whether the StdOut
  844.      can or cannot be redirected to a file or another device (such as NUL or
  845.      PRN) by the commands '>' or '>>' from the DOS command line.
  846.  
  847.       /X+   The INT 21/40h/1 DOS video output can be redirected to
  848.         a file or another device.  (This is the normal default
  849.                condition.)
  850.  
  851.       /X-   The INT 21/40h/1 DOS video output is always displayed,
  852.         i.e. it cannot be redirected.  This provides a further
  853.         acceleration of DOS video output but at the price of a
  854.         less-than-transparent operation.
  855.  
  856.      Defaults: /X = /X+; null switch = /X+ on installation.
  857.  
  858.      NOTE:  If switch X is not enabled, the acceleration of DOS video output
  859.         via switch /Z+ (see below) conflicts with the redirection of DOS
  860.         output to another device or to a file.  If such a redirection is
  861.         needed, either enable switch X (/X+) or disable switch Z (/Z-).
  862.  
  863.  
  864.     SWITCH /Z±
  865.  
  866.      Directs the video output through INT 21h, function 40h, device handle 1
  867.      ('write to StdOut device') to the DOS console driver or the accelerator
  868.      module of VIz.  Mediation of the INT 21h/40h/1-output to VIz produces a
  869.      considerable acceleration of DOS text output in MS-DOS versions 2 to 5.
  870.  
  871.       /Z-   INT 21/40h/1 video output is allowed to be processed by
  872.         the installed CON driver.
  873.  
  874.       /Z+   INT 21/40h/1 video output is redirected to the teletype
  875.         subservice of VIz.
  876.  
  877.      Defaults: /Z = /Z+; null switch = /Z+ on installation.
  878.  
  879.  
  880.    COMMENTS
  881.  
  882.    The comments may be added in the DOS command line after the specification
  883.    of the switches.  These comments, which may be useful in clarifying batch
  884.    files, must be preceded by a semicolon (;), and are ignored by VIz.
  885.  
  886.    Do not use the DOS redirection and pipe characters in the comments as DOS
  887.    will attempt to implement the implied redirection or pipe request.
  888.  
  889.  
  890.    STATUS/USAGE/HELP PANELS
  891.  
  892.    Executing the program with switch /? selected allows access to the Status/
  893.    Usage and Help panels. (If a Mouse pointing device driver, compatible with
  894.    the Microsoft Mouse driver version 6.0 or higher is loaded and active, all
  895.    of the services provided by these panels can also be activated by pointing
  896.    the mouse to specific areas of the screen and clicking either button.  The
  897.    mouse driver state is saved prior to the display, to be restored later, if
  898.    sufficient memory is available.)
  899.  
  900.    The STATUS/USAGE panel, which is shown first, describes status information
  901.    for the resident and some video services. The bottom line shows the status
  902.    of the StdOut stream redirection, ANSI filter, DOS text processing and the
  903.    current value of the video page and video mode.  A succinct explanation of
  904.    the status of the highlighted service can be obtained by pressing the left
  905.    or right keypad arrow keys or by clicking the mouse upon the screen button
  906.    labelled <Status>; these explanations can be erased by pressing key <F10>.
  907.    The video mode number shown in the Status panel is followed by an asterisk
  908.    if a mode higher than n+128 is detected (AT and PS/2 machines only); thus,
  909.    mode 131 is displayed as 3*.
  910.  
  911.    The USAGE subpanel shows a menu for the command switches: To cycle between
  912.    the main and the auxiliary menu, press key <F2> or <M>, or click the mouse
  913.    upon the screen button labelled <Menu>.  If the resident is installed, the
  914.    status of some 'on/off' command switches is displayed by '+' or '-' before
  915.    a given menu entry.
  916.  
  917.    Press the key <F3> or click the mouse on the screen button labelled <Time>
  918.    to run brief video benchmarks for BIOS and DOS-mediated text scrolling and
  919.    for direct screen writes. Exit the benchmarks panel by pressing key <Esc>.
  920.  
  921.    The HELP panel provides a summary description of the program and commands,
  922.    and is displayed if key <F1> or <H> is pressed from the Status/Usage panel
  923.    (or if the mouse is clicked upon the screen button labelled <Help>). Press
  924.    the keypad cursor keys (Home/End, PgUp/PgDn, arrows) to scroll the display
  925.    down or up. Pressing the <F1> key once skips the brief program summary and
  926.    positions the text on the "Usage" section directly; pressing <F1> a second
  927.    time positions the text on the "Switches" section directly.  Press <F2> or
  928.    <Esc> key to return to the Status/Usage panel.
  929.  
  930.    Press key <X> or click the mouse upon the screen button labelled <eXit> to
  931.    return to the DOS-prompt command line from either panel.
  932.  
  933.    When the program is waiting for keyboard or mouse input during the display
  934.    of the above panels, it calls repeatedly the 'IDLE' interrupts of DOS: INT
  935.    28h and (if MS-DOS or IBM PC-DOS 5 is being used) INT 2Fh, function 1608h.
  936.    INT 28h allows a potential background activation of (some) other residents
  937.    while INT 2Fh/1608h allows DOS to suspend the idle program temporarily and
  938.    transfer control to another program.
  939.  
  940.  
  941.  
  942.    8. INSTALLATION IN UPPER MEMORY
  943.  
  944.    This section describes in more detail aspects of the active (i.e., self-
  945.    loading) or passive (e.g. via DOS LOADHIGH) installation of the resident
  946.    in the upper memory region.
  947.  
  948.  
  949.    DIRECT UPPER-MEMORY AREA LOADING
  950.  
  951.    The utility can self-install the resident in the upper memory area (UMA),
  952.    that is, RAM addresses between 640 KB and 1,024 KB, via switch /H (or its
  953.    subfunctions /Hn, /H@, and /Hn@). Program releases prior to revision 4.02
  954.    lack this feature.
  955.  
  956.    The allocation of UMA blocks (UMBs) is arbitrated by an XMS manager (XMM)
  957.    version 2.0 or higher; the XMM must be installed prior to the UMB-loading
  958.    of the resident.  Allocation also requires the remapping of UMA addresses
  959.    by a UMB provider, when such a task is not implemented by the XMM itself.
  960.    The XMM HIMEM.SYS and the UMB-provider EMM386.EXE are distributed with MS
  961.    DOS 5.0; the allocation of UMBs is controlled by DOS when these 2 drivers
  962.    are installed, and the command 'DOS=UMB' is added to the CONFIG.SYS file.
  963.    Of course, other 386-specific memory managers, such as 386MAX or QEMM386,
  964.    provide both UMB remapping and XMS support.  All XMMs require DOS version
  965.    3.0 or higher.
  966.  
  967.    Switch /Hn, where A000 ≤ n ≤ FFFF (hexadecimal), allows the specification
  968.    of a minimum upper-memory limit for the UMB to avoid UMA regions having a
  969.    very slow access time (or to preserve regions with a fast access time for
  970.    other utilities that require faster times, such as a disk cache or screen
  971.    accelerator), or to avoid fragmentation of the UMA when UMB allocation is
  972.    not controlled by DOS 5, but by the XMM itself.  Such a fragmentation may
  973.    occur when the XMM allocates blocks on a first-fit basis, i.e., the first
  974.    available UMB having the lowest UMA address is allocated, irrespective of
  975.    whether or not a (smaller) block matching the requested size is available
  976.    at a higher UMA address.  Unless the size of the available UMBs increases
  977.    with increasing memory address, first-fit allocation of a small UMB leads
  978.    to the breaking of large UMA blocks into smaller ones, thus hampering the
  979.    UMB installation of larger residents.
  980.  
  981.    When DOS controls the UMB allocation, the program enforces the allocation
  982.    of the resident block on a best-fit basis when <n> is not specified, that
  983.    is, all available blocks are searched (by DOS), and the one matching most
  984.    closely the size requested is allocated.
  985.  
  986.    When DOS controls UMB allocation and <n> is specified, UMBs are allocated
  987.    on a first-fit basis.  While this may contribute to UMA fragmentation, it
  988.    allows for the checking of a minimum memory limit in those cases in which
  989.    the selection or avoidance of a specific UMA region is more important.
  990.  
  991.    Hence, compared to the upper-memory installation provided by the LOADHIGH
  992.    command of DOS 5.0, or similar services provided by some memory managers,
  993.    program self-loading into a UMB has several advantages, including: (1) it
  994.    does not require an initial free block of upper memory of the size of the
  995.    entire program (as opposed to the size of its resident only), (2) it does
  996.    allow user control on the selection of the upper-memory block, and (3) it
  997.    can help reduce UMA fragmentation.
  998.  
  999.    NOTE: The address and size of available UMBs can be obtained with MEM.EXE
  1000.      (when DOS controls UMB allocation) or via the memory manager itself
  1001.      (when the allocation is controlled by 386-specific memory managers.
  1002.      In either case, such data can also be obtained with UMAX.EXE, a UMA
  1003.      mapping utility that is distributed by the author.
  1004.  
  1005.  
  1006.    UMA LOADING VIA MEMORY MANAGERS OR DOS 5
  1007.  
  1008.    Of course, the resident can also be installed in the UMA via a 386-memory
  1009.    manager or via (UMB-linked) MS-DOS 5 provided that there is enough memory
  1010.    for the actual size of the entire program, and any additional memory that
  1011.    may be needed by the loading utility.
  1012.  
  1013.    To minimize disk storage, the program is distributed as a compressed file
  1014.    that expands upon its execution. The difference between the actual loaded
  1015.    size and the nominal directory size may create conflicts with high-memory
  1016.    loading programs that fail to measure the actual size: When the available
  1017.    high memory is not sufficient to permit the file expansion, but is larger
  1018.    than the nominal directory size, such programs will load the (compressed)
  1019.    utility. The subsequent expansion will then overwrite adjacent memory and
  1020.    likely crash the memory manager or DOS.  The executable file expands by a
  1021.    factor of less than 2.
  1022.  
  1023.    An additional 4,600 bytes of free memory are required to restore contents
  1024.    of the screen after switch /? or /C?.  Also, an additional 2,600 bytes of
  1025.    free memory are required to implement switch /F14 or /F35.
  1026.  
  1027.  
  1028.    UMA UPDATING
  1029.  
  1030.    When the program has been installed in upper memory, it does not require
  1031.    a high-memory loading utility to update its resident and all updates can
  1032.    be made via program executions from the DOS-command line.  This obviates
  1033.    the restriction (of some memory systems) of having to maintain a pool of
  1034.    of free upper memory simply to load the entire program to update a small
  1035.    resident.  Program releases prior to revision 3.40 lack this feature.
  1036.  
  1037.  
  1038.    UMA DEALLOCATION
  1039.  
  1040.    When resident deallocation is requested (switch /U) from the DOS command
  1041.    line (as opposed to via upper-memory loading utilities), the resident is
  1042.    removed from memory even when it was loaded in the UMA; the confirmation
  1043.    request of revisions 3.00 through 3.16 is no longer required.
  1044.  
  1045.    When switch /U is requested via a high-memory utility be aware that some
  1046.    of these utilities warn that a "resident installation has failed."  This
  1047.    warning is harmless and may be ignored.
  1048.  
  1049.  
  1050.    MEMORY MAPPING UTILITIES
  1051.  
  1052.    Although the program releases its own copy of the environment at the time
  1053.    of installation (to reduce resident size), the resident can be identified
  1054.    in memory usage maps by the label
  1055.  
  1056.                     VIzxxx
  1057.  
  1058.    that appears in the command-line listing of most memory mapping utilities
  1059.    irrespective of the actual contents of the command line if the program is
  1060.    loaded in conventional memory; 'xxx' in the label represents the revision
  1061.    number (e.g., 424).
  1062.  
  1063.    However, when UMB loading is mediated by the XMS directly (e.g., extended
  1064.    memory manager and DOS versions 2 to 4, or DOS 5 not configured under the
  1065.    command 'DOS=UMB'), and the resident is installed in a UMB via switch /H,
  1066.    most memory mapping utilities do not list the allocated UMB, lump it with
  1067.    other allocated blocks, or fail to show the name of the resident.  If the
  1068.    identification of the UMB resident is required, use switch /H@ or /Hn@ to
  1069.    load in lower RAM a small resident marker that shows up in memory maps.
  1070.  
  1071.    When the allocation of UMBs is controlled by DOS (e.g. DOS 5.0 configured
  1072.    under the command DOS=UMB, and the drivers HIMEM.SYS and EMM386.EXE), the
  1073.    UMB resident can be identified with some mapping utilities (e.g. MEM.EXE)
  1074.    although it is often listed as "Data" instead of "Program."  Other memory
  1075.    mapping utilities identify the UMB resident only when an associated lower
  1076.    memory marker is also installed.
  1077.  
  1078.  
  1079.  
  1080.    9. TECHNICAL INFORMATION
  1081.  
  1082.    INTERRUPTS
  1083.  
  1084.    Channel 0 of the 8253/8254 timer chip produces a hardware interrupt (IRQ0),
  1085.    interrupt 8h, about 18.2 times a second that is used by the system time-of-
  1086.    day clock. When the cursor module is installed, switch /Vn (n=0 or 1 to 99)
  1087.    forces the display of the block cursor, either in continuous or alternating
  1088.    manner. Cursor shape is implemented via commands using either 16-bit (word)
  1089.    or 8-bit (byte) output, depending on the VIz release that was selected.
  1090.  
  1091.    The accelerator module of VIz intercepts the ROM BIOS video interrupt, 10h.
  1092.    When the system is in page 0 and a text mode, video acceleration occurs for
  1093.    subfunctions 0h through Eh, except for subfunctions 4h, 7h, Bh, and Ch.
  1094.  
  1095.    Starting with version 2.0, DOS allows the redirection of the Standard Input
  1096.    (StdIn) and Standard Output (StdOut) console device, permitting programs to
  1097.    send input to or to receive output from other programs.  Unless redirected,
  1098.    the StdIn comes from the keyboard and the StdOut goes to the screen.  These
  1099.    and some other devices can be addressed by predefined DOS 'file handles' as
  1100.    if they were disk files.  A common DOS-mediated technique to send output to
  1101.    the screen is to write to the handle 1 (StdOut) via interrupt 21h, function
  1102.    40h; in fact, this is the preferred method of DOS-mediated video output for
  1103.    MS-DOS version 2.0 or higher.
  1104.  
  1105.    The accelerator module of VIz also intercepts interrupt 21h. Switch /Z+ re-
  1106.    directs to VIz the INT-21h/40h/1 video stream to the StdOut, resulting in a
  1107.    significant acceleration of DOS-mediated video output. This acceleration is
  1108.    not increased by setting the DOS mode to binary (see switch /R). Switch /Z-
  1109.    restores the INT-21h/40h/1 stream to the current StdOut device.
  1110.  
  1111.    If switch /X+ has been selected (the default condition), the implementation
  1112.    of the INT-21h/40h/1 video stream by VIz is fully transparent.  Switch /X-,
  1113.    however, avoids a DOS-mediated redirection of the StdOut (i.e. the commands
  1114.    '>' and '>>' at the DOS command line are no longer able to redirect the DOS
  1115.    video output, such as '> NUL' to avoid some messages). Under switch /X- VIz
  1116.    provides an even faster acceleration of DOS video output, since it does not
  1117.    have to check whether the output is being redirected to the printer or to a
  1118.    file.
  1119.  
  1120.    Switch /Z selection is not disregarded when ANSI.SYS, ANSI.COM, or the ANSI
  1121.    filter of VIz is active.  The redirection of StdOut to VIz by /Z+, however,
  1122.    will conflict with ANSI commands sent to the CON device via standard-output
  1123.    calls to INT 21h, function 40h/1.  In contrast, ANSI commands using INT 29h
  1124.    are not affected by switch /Z+ (see above).
  1125.  
  1126.    The ANSI-compatible module of VIz intercepts interrupt 29h, an undocumented
  1127.    feature present in all recent versions of DOS. INT 29h is normally provided
  1128.    by the built-in console device driver of DOS, and consists of a call to the
  1129.    BIOS interrupt 10h.  DOS uses INT 29h instead of the normal request-passing
  1130.    mechanism to accelerate output to the current 'CON' device. The ANSI module
  1131.    filters this output.
  1132.  
  1133.    If a request to inactivate the installed ANSI filter is encountered (switch
  1134.    /A-), VIz checks whether the INT 29h can be restored to its original memory
  1135.    address.  If the revectoring is not possible (i.e., if another resident has
  1136.    also intercepted INT 29h), this filter remains partially active in order to
  1137.    handle an ANSI escape sequence generated by COMMAND.COM to clear the screen
  1138.    when a CLS command is detected (see below); other ANSI escape sequences are
  1139.    ignored by the filter and passed to the screen.  Hence, when revectoring is
  1140.    possible, switch /A- has the same effect as installing VIz without a switch
  1141.    /A, except that the memory occupied by the ANSI filter is not released; the
  1142.    filter is reactivated by a subsequent call to execute VIz with switch /A+.
  1143.  
  1144.  
  1145.    CLS COMMAND & INT 29h
  1146.  
  1147.    The internal console device driver installed during booting handles the CLS
  1148.    as well as INT-29h service. The CLS procedure of COMMAND.COM first tests to
  1149.    see if (1) the standard-output handle is associated with a character device
  1150.    driver (bit 7=1), and (2) the driver services INT 29h (bit 4=1).  If one or
  1151.    both tests fail, or if both tests are successful but the vector for INT 29h
  1152.    does not point to the memory segment of the DOS kernel, COMMAND.COM outputs
  1153.    the ANSI escape sequence <Esc>[2J to INT 29h; otherwise, it makes a call to
  1154.    INT 10h, subfunction 6 of the BIOS to clear the screen.
  1155.  
  1156.    If INT 29h cannot be revectored upon /A-, the partial driver activity slows
  1157.    down slightly the DOS video output whenever the ASCII character 27 (Esc) is
  1158.    found in the character stream.  The partial activity is needed, however, as
  1159.    DOS issues an ANSI escape sequence to clear the screen whenever INT 29h has
  1160.    been revectored.  Thus, if VIz were not to retain its ANSI driver partially
  1161.    active when revectoring of INT 29h is not possible, the DOS escape sequence
  1162.    would be displayed (without clearing the screen) whenever a CLS command was
  1163.    issued.
  1164.  
  1165.  
  1166.    ENVIRONMENT VARIABLE 'VIZ'
  1167.  
  1168.    When the program is executed without arguments from the DOS command line
  1169.    (or a batch file), it searches the DOS environment for a variable having
  1170.    the format:
  1171.             VIZ=/SWITCH1/SWITCH2..../SWITCHn
  1172.  
  1173.    Up to 128 characters are allowed after the equal sign. This string can be
  1174.    incorporated to the environment block via the 'SET' command of DOS or via
  1175.    switch /E of the program (see below).  Program releases prior to revision
  1176.    3.63 lack this feature.
  1177.  
  1178.    While the SET command modifies the current DOS environment block, whether
  1179.    it is the global or a local one, switch /E only modifies the global block
  1180.    (even when the program is executed via a secondary COMMAND.COM, as in the
  1181.    case of shelling out to DOS from an application).   Notice that the local
  1182.    environment block is only a copy of the global block and lacks sufficient
  1183.    room to increase significantly the length of a variable, and that changes
  1184.    made to a local environment are not inherited by the global one.
  1185.  
  1186.    When searching for the environment variable, the program uses the current
  1187.    DOS environment block, whether it is the global or a local one.
  1188.  
  1189.    A recommended use of the environment string is to specify a default /Cn:n
  1190.    setting (e.g. /C03:00:20:30:40:50:01:77:70:11:22:33:44:55:66:76) that can
  1191.    be restored simply by executing VIz without any arguments after the color
  1192.    palette has been changed.
  1193.  
  1194.  
  1195.    DOS ERRORLEVELS
  1196.  
  1197.    Upon exit its to DOS, the program passes execution status values that can
  1198.    be tested via ERRORLEVEL commands in a batch file.  The following are the
  1199.    values for revision 4.20 or higher:
  1200.  
  1201.           Value   Condition
  1202.           -----   --------------------------------------
  1203.         255   Failure of cyclical redundancy check
  1204.         255   CPU type cannot execute version code
  1205.         255   Invalid DOS version
  1206.         254   Invalid ANSI (switch /A) request
  1207.         253   Unknown/incompatible video adapter
  1208.         252   Not enough additional RAM (/C? /? /F14 /F35)
  1209.         251   Hooked interrupts revectored
  1210.         250   Invalid cursor (switch /Vn) request
  1211.         128   XMM not installed or UMB load/unload error
  1212.          96   DOS environment error
  1213.          64   Incomplete color palette data list
  1214.          32   Invalid color palette datum
  1215.          16   Invalid video font for adapter and/or page
  1216.           8   Invalid video mode request
  1217.           4   Invalid video page for adapter and/or font
  1218.           2   Invalid video adapter for the request
  1219.           1   Unknown or invalid switch request
  1220.           0   Successful execution
  1221.  
  1222.  
  1223.    Since some error conditions in the range from 1 through 128 do not cancel
  1224.    program execution (nonfatal) and the error values are additive, the final
  1225.    ERRORLEVEL value may represent more than a single error condition.
  1226.  
  1227.    Program releases prior to revision 3.10 lack this feature.
  1228.  
  1229.  
  1230.  
  1231.   10. COPYRIGHT & LICENSE
  1232.  
  1233.   This documentation, programs, and other files distributed in this software
  1234.   package (the "Software")  are the copyrighted property of FM de Monasterio
  1235.   (the "Author"), who provides the Software and licenses its use. All rights
  1236.   are reserved.
  1237.  
  1238.   The file VIZ.REG contains a form needed to register this Software.
  1239.  
  1240.   SINGLE USER LICENSE.  Upon registration, you are granted a nontransferable
  1241.   license to use this Software in a single computer at a time.  The Software
  1242.   may also be transferred to another computer, provided that the Software is
  1243.   used only in one (1) computer at any time; under the license, the Software
  1244.   may NOT be installed on a network server.
  1245.  
  1246.   SITE/15-PCs LICENSE.  Upon registration, you are granted a nontransferable
  1247.   license to use this Software in a single site, or a set of sites, provided
  1248.   this Software is not used in more than fifteen (15) computers at any time,
  1249.   and that such computers are located exclusively within the site.  Licenses
  1250.   for more machines are available at discounted prices.
  1251.  
  1252.   SOFTWARE BUNDLING LICENSE.  Please write to the Author.
  1253.  
  1254.   REFUNDS POLICY.  If a problem notified within ninety (90) days of shipping
  1255.   of the registered copy cannot be solved, the registration fee (but not the
  1256.   shipping costs) will be refunded upon receiving a written request with the
  1257.   original diskette(s) enclosed.
  1258.  
  1259.   UPGRADE POLICY.  Program upgrades are limited to licensed users.  Upgrades
  1260.   within the same major version (e.g. release 4.00 through 4.99) are free of
  1261.   charge when a self-addressed, stamped, 5.25" diskette mailer with a 360-KB
  1262.   diskette is included with the request. Other upgrades are charged half the
  1263.   (single-user/site) registration fee.  See enclosed file VIZ.UPG.
  1264.  
  1265.   TECHNICAL SUPPORT.  A phone number for technical support is made available
  1266.   to site licenses for 100 machines or more; other licensed users must write
  1267.   to the Author who will contact them.
  1268.  
  1269.  
  1270.   U.S. GOVERNMENT INFORMATION
  1271.  
  1272.   The use, duplication, or disclosure by the U.S. Government of the Software
  1273.   is subject to the restricted rights applicable to commercial software that
  1274.   are specified in the subdivision (b.3.ii) of the 'Rights in Technical Data
  1275.   and Computer Software' clause, document DFARS 52.227-7013. The contractor/
  1276.   manufacturer is FM de Monasterio, P.O. Box 219, Cabin John, MD 20818-0219.
  1277.  
  1278.  
  1279.   DISTRIBUTION
  1280.  
  1281.   You may distribute this Software via magnetic and/or electronic means, but
  1282.   you are specifically prohibited from:
  1283.  
  1284.   - Charging fees or asking donations in exchange of or payment
  1285.     for copies of this Software.
  1286.  
  1287.   - Distributing this Software with commercial products without
  1288.     the written, express permission in advance from the author.
  1289.  
  1290.   - Distributing this Software via a for-profit organization or
  1291.     group, either alone or with other software.
  1292.  
  1293.   - Modifying any contents of this Software, including, but not
  1294.     limited to, the copyright notice and this license.
  1295.  
  1296.  
  1297.   The unauthorized copying, decompiling or disassembling of this Software is
  1298.   prohibited.  Any other use of this Software is also prohibited without the
  1299.   express, written permission in advance from the author.
  1300.  
  1301.   Latest program releases may be found at the Information Exchange BBS, 703-
  1302.   836-0748, as a compressed archive file.
  1303.  
  1304.  
  1305.   WARRANTY DISCLAIMER
  1306.  
  1307.   The Author cannot and does not warrant that any functions contained in the
  1308.   Software will meet your requirements, or that its operations will be error
  1309.   free.  The entire risk as to the Software performance or quality, or both,
  1310.   is solely with the user and not the Author.  You assume responsibility for
  1311.   the selection of the program to achieve your intended results, and for the
  1312.   installation, use, and results obtained from the Software.
  1313.  
  1314.   The Author makes no warranty, either implied or expressed, including with-
  1315.   out limitation any warranty with respect to this Software documented here,
  1316.   its quality, performance, or fitness for a particular purpose. In no event
  1317.   shall the Author be liable to you for damages, whether direct or indirect,
  1318.   incidental, special, or consequential arising out the use of or any defect
  1319.   in the Software, even if the Author has been advised of the possibility of
  1320.   such damages, or for any claim by any other party.
  1321.  
  1322.   All other warranties of any kind, either express or implied, including but
  1323.   not limited to the implied warranties of merchantability and fitness for a
  1324.   particular purpose, are expressly excluded.
  1325.  
  1326.  
  1327.   LIMITATION OF REMEDIES
  1328.  
  1329.   The information contained in the documentation for the Software is subject
  1330.   to change without notice.
  1331.  
  1332.   The Author's entire liability, and your exclusive remedy shall be: (1) the
  1333.   replacement of an original Software diskette not meeting the above Limited
  1334.   Warranty and which is returned to the Author along with proof of purchase,
  1335.   or (2), if the Author is unable to deliver a replacement diskette which is
  1336.   free of defects, you may terminate the License Agreement by returning this
  1337.   Software and the corresponding license fee will be returned.
  1338.  
  1339.   By using the Software, you acknowledge (1) to have read and understood all
  1340.   parts of this document and (2) to have agreed with and accepted all of its
  1341.   provisions without any reservation.
  1342.  
  1343.                    ---------
  1344.   Refer all inquiries to:
  1345.                 FM de Monasterio
  1346.                 P.O. Box 219
  1347.                 Cabin John, MD 20818-0219
  1348.                 USA
  1349.  
  1350.     ┌─────────────────────────────────────────────────────────────┐
  1351.     │ Trademarked names are the property of the respective owners │
  1352.     └─────────────────────────────────────────────────────────────┘
  1353.  [END]
  1354.